<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxVehicleClutchData Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxVehicleClutchData.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classPxVehicleClutchData-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxVehicleClutchData Class Reference<div class="ingroups"><a class="el" href="group__vehicle.html">Vehicle</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="PxVehicleComponents_8h_source.html">PxVehicleComponents.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a963c71a977c0bfbb465fd75d1e106dc0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#a963c71a977c0bfbb465fd75d1e106dc0">PxVehicleClutchData</a> ()</td></tr>
<tr class="separator:a963c71a977c0bfbb465fd75d1e106dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f50479c769bfc6ae880b92036abce8d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#a5f50479c769bfc6ae880b92036abce8d">PxVehicleClutchData</a> (const <a class="el" href="group__foundation.html#ga0326e4ec6e9082ac70f32df5edc6eb5f">PxEMPTY</a>)</td></tr>
<tr class="separator:a5f50479c769bfc6ae880b92036abce8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:afa3118a1b2b8d091a96a29f1b03ec339"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#afa3118a1b2b8d091a96a29f1b03ec339">mStrength</a></td></tr>
<tr class="memdesc:afa3118a1b2b8d091a96a29f1b03ec339"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strength of clutch.  <a href="#afa3118a1b2b8d091a96a29f1b03ec339">More...</a><br /></td></tr>
<tr class="separator:afa3118a1b2b8d091a96a29f1b03ec339"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f1a138c63ae5bd015ed18de90168dab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxVehicleClutchAccuracyMode.html#a8cb4ae31cf929f344f2049939b9f61ce">PxVehicleClutchAccuracyMode::Enum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#a8f1a138c63ae5bd015ed18de90168dab">mAccuracyMode</a></td></tr>
<tr class="memdesc:a8f1a138c63ae5bd015ed18de90168dab"><td class="mdescLeft">&#160;</td><td class="mdescRight">The engine and wheel rotation speeds that are coupled through the clutch can be updated by choosing one of two modes: eESTIMATE and eBEST_POSSIBLE.  <a href="#a8f1a138c63ae5bd015ed18de90168dab">More...</a><br /></td></tr>
<tr class="separator:a8f1a138c63ae5bd015ed18de90168dab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64f27aab12c4d3f6deae242e04c95e3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#a64f27aab12c4d3f6deae242e04c95e3f">mEstimateIterations</a></td></tr>
<tr class="memdesc:a64f27aab12c4d3f6deae242e04c95e3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tune the mathematical accuracy and computational cost of the computed estimate to the wheel and engine rotation speeds if eESTIMATE is chosen.  <a href="#a64f27aab12c4d3f6deae242e04c95e3f">More...</a><br /></td></tr>
<tr class="separator:a64f27aab12c4d3f6deae242e04c95e3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a1456ebcfc1509a1ce9ef013a1f981c45"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#a1456ebcfc1509a1ce9ef013a1f981c45">isValid</a> () const</td></tr>
<tr class="separator:a1456ebcfc1509a1ce9ef013a1f981c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a64734e299b40dacd3de949b2cabd8b67"><td class="memItemLeft" align="right" valign="top">PxU8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#a64734e299b40dacd3de949b2cabd8b67">mPad</a> [4]</td></tr>
<tr class="separator:a64734e299b40dacd3de949b2cabd8b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aa2f8773ce851c65e3c7d31b8991ea8f8"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxVehicleClutchData.html#aa2f8773ce851c65e3c7d31b8991ea8f8">PxVehicleDriveSimData</a></td></tr>
<tr class="separator:aa2f8773ce851c65e3c7d31b8991ea8f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a963c71a977c0bfbb465fd75d1e106dc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a963c71a977c0bfbb465fd75d1e106dc0">&#9670;&nbsp;</a></span>PxVehicleClutchData() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">PxVehicleClutchData::PxVehicleClutchData </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a5f50479c769bfc6ae880b92036abce8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f50479c769bfc6ae880b92036abce8d">&#9670;&nbsp;</a></span>PxVehicleClutchData() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">PxVehicleClutchData::PxVehicleClutchData </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__foundation.html#ga0326e4ec6e9082ac70f32df5edc6eb5f">PxEMPTY</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1456ebcfc1509a1ce9ef013a1f981c45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1456ebcfc1509a1ce9ef013a1f981c45">&#9670;&nbsp;</a></span>isValid()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool PxVehicleClutchData::isValid </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="aa2f8773ce851c65e3c7d31b8991ea8f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2f8773ce851c65e3c7d31b8991ea8f8">&#9670;&nbsp;</a></span>PxVehicleDriveSimData</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classPxVehicleDriveSimData.html">PxVehicleDriveSimData</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8f1a138c63ae5bd015ed18de90168dab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f1a138c63ae5bd015ed18de90168dab">&#9670;&nbsp;</a></span>mAccuracyMode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxVehicleClutchAccuracyMode.html#a8cb4ae31cf929f344f2049939b9f61ce">PxVehicleClutchAccuracyMode::Enum</a> PxVehicleClutchData::mAccuracyMode</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The engine and wheel rotation speeds that are coupled through the clutch can be updated by choosing one of two modes: eESTIMATE and eBEST_POSSIBLE. </p>
<dl class="section note"><dt>Note</dt><dd>If eESTIMATE is chosen the vehicle sdk will update the wheel and engine rotation speeds with estimated values to the implemented clutch model.</dd>
<dd>
If eBEST_POSSIBLE is chosen the vehicle sdk will compute the best possible solution (within floating point tolerance) to the implemented clutch model. This is the recommended mode.</dd>
<dd>
The clutch model remains the same if either eESTIMATE or eBEST_POSSIBLE is chosen but the accuracy and computational cost of the solution to the model can be tuned as required. </dd></dl>

</div>
</div>
<a id="a64f27aab12c4d3f6deae242e04c95e3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64f27aab12c4d3f6deae242e04c95e3f">&#9670;&nbsp;</a></span>mEstimateIterations</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxVehicleClutchData::mEstimateIterations</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Tune the mathematical accuracy and computational cost of the computed estimate to the wheel and engine rotation speeds if eESTIMATE is chosen. </p>
<dl class="section note"><dt>Note</dt><dd>As mEstimateIterations increases the computational cost of the clutch also increases and the solution approaches the solution that would be computed if eBEST_POSSIBLE was chosen instead.</dd>
<dd>
This has no effect if eBEST_POSSIBLE is chosen as the accuracy mode.</dd>
<dd>
A value of zero is not allowed if eESTIMATE is chosen as the accuracy mode. </dd></dl>

</div>
</div>
<a id="a64734e299b40dacd3de949b2cabd8b67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64734e299b40dacd3de949b2cabd8b67">&#9670;&nbsp;</a></span>mPad</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">PxU8 PxVehicleClutchData::mPad[4]</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="afa3118a1b2b8d091a96a29f1b03ec339"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa3118a1b2b8d091a96a29f1b03ec339">&#9670;&nbsp;</a></span>mStrength</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal PxVehicleClutchData::mStrength</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Strength of clutch. </p>
<dl class="section note"><dt>Note</dt><dd>The clutch is the mechanism that couples the engine to the wheels. A stronger clutch more strongly couples the engine to the wheels, while a clutch of strength zero completely decouples the engine from the wheels. Stronger clutches more quickly bring the wheels and engine into equilibrium, while weaker clutches take longer, resulting in periods of clutch slip and delays in power transmission from the engine to the wheels. The torque generated by the clutch is proportional to the clutch strength and the velocity difference between the engine's rotational speed and the rotational speed of the driven wheels after accounting for the gear ratio. The torque at the clutch is applied negatively to the engine and positively to the driven wheels.</dd>
<dd>
Specified in kilograms metres-squared per second (kg m^2 s^-1)</dd></dl>
<p><b>Range:</b> [0,PX_MAX_F32)<br />
 </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxVehicleComponents_8h_source.html">PxVehicleComponents.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxVehicleClutchData.html">PxVehicleClutchData</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
